/**
 *  Copyright (C) 2008-2013  Telosys project org. ( http://www.telosys.org/ )
 *
 *  Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *          http://www.gnu.org/licenses/lgpl.html
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.telosys.common.xml;

import java.io.PrintWriter;

/**
 * Interface to give XML mapping capabilities to a Java object. <br>
 * It provides bidirectional mapping :<br>
 * - from XML to java object <br>
 * - from Java object to XML <br>
 * 
 * @author Laurent GUERIN
 *  
 */
public interface IXmlWrapper
{
    /**
     * Returns the class of the bean managed by the XML mapper
     * @return the class
     */
    public Class<?> getBeanClass();

    /**
     * Creates an new instance of the b managed by the XML mapper 
     * @return bean instance
     */
    public Object createBean();

    /**
     * Set the given field value in the object field corresponding to the given field name.
     * @param bean : the bean to update
     * @param sFieldName : the name of the field in the XML flow 
     * @param sFieldValue : the value of the field
     */
    public void setXmlFieldValue(Object bean, String sFieldName, String sFieldValue);
     
    /**
     * Print the given bean as XML tag on the given output
     * @param out
     * @param bean
     * @param sTagName
     */
    public void toXml(PrintWriter out, Object bean, String sTagName );

}